home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / fsearch.zip / FSEARCH.DOC < prev    next >
Text File  |  1992-03-01  |  8KB  |  200 lines
  1.  
  2.  
  3.                 *******************************************
  4.  
  5.                                 FSEARCH 1.0
  6.                    a PCBoard file list searching utility
  7.  
  8.                       (c) 1992 by Timothy C. Barmann
  9.  
  10.                 *******************************************
  11.  
  12.  
  13.  
  14. USAGE
  15. -----
  16. C:>FSEARCH file1 [file2 ... file_n] /word1 [/word2 ... /word8] [-A] [-S]
  17.  
  18. DESCRIPTION
  19. -----------
  20. FSEARCH has a very specific purpose. It searches file lists found on
  21. bulletin boards running PCBoard software, for a particular word or words.
  22. The program works similarly to the (z)ippy search function on PCBoard
  23. BBS's, except that it's used offline. FSEARCH was written to help bulletin
  24. board callers to find files they are interested in downloading before
  25. calling the BBS. FSEARCH will scan through any part of the file list text,
  26. including filenames, sizes, dates and up to 8 lines of the extended
  27. description of each file.
  28.  
  29. FSEARCH will run on any IBM compatible computer and should be able to read
  30. file lists found on BBS's using PCBoard 14.x software.
  31.  
  32. Note: It's recommended that you load ANSI.SYS on your computer before
  33. running FSEARCH. See below for more information.
  34.  
  35.  
  36. WHAT'S A FILE LIST?
  37. -------------------
  38. A file list is a text file that describes a particular bulletin board's
  39. files available for downloading.  PCBoard file lists are formatted in a
  40. unique way and contain a file's name, size, date it was created, and
  41. description. The file list itself often is posted on the bulletin board
  42. and can be downloaded.  If you cannot find such a file on the PCBoard
  43. bulletin board you call, ask your sysop how you might be able to get it.
  44. (If you are still unsure what a file list looks like, see SAMPLE.LST
  45. included with this package.) FSEARCH will ignore any lines that don't
  46. conform to the PCBoard file list format.
  47.  
  48. HOW TO USE FSEARCH
  49. ------------------
  50. C:>FSEARCH file1 [file2 ... file_n] /word1 [/word2 ... /word8] [-A] [-S]
  51.  
  52. Where:
  53.  
  54. file1.ext    is the name of the file you want to search. At least one
  55.              filename is required. Wildcards and full pathnames are
  56.              valid.
  57.  
  58. file2.ext    The second file you want to search. Enter as many filenames
  59.              as you wish.
  60.  
  61. /word1       The forward slash followed by the word you want to find.
  62.              If searching for a phrase, it must be surrounded by quotation
  63.              marks. Ex: "/find this phrase". At least one word or phrase
  64.              to search for is required. The search is NOT case sensitive.
  65.  
  66. /word2       Finds word1 and word2 and whatever other words or phrases you
  67.              specify, up to 8. It finds only records that contain all
  68.              the words or phrases. OR searches are not supported.
  69.  
  70. -A           Turns off the screen codes ANSI.SYS uses to highlight
  71.              keywords found.  Use this option if you choose not to load
  72.              ANSI.SYS or are redirecting the output to a file. This switch
  73.              is optional.  See below for more information on redirection.
  74.  
  75. -S           Suppresses the "scanning file xxx for ..." remarks as FSEARCH
  76.              is working.
  77.  
  78. Separate parameters with spaces.  They can be entered in any order on the
  79. command line with the exception of the DOS commands that allow redirecting
  80. and pausing of the output.  Those commands must come at the end of the
  81. command line.  Those commands are explained in more detail below.
  82.  
  83. Use the enclosed sample file list included with this package called
  84. SAMPLE.LST to try the program out.
  85.  
  86. EXAMPLES:
  87. ---------
  88. C:>FSEARCH sample.lst /bart
  89.  
  90.   displays any records that contain "bart" in the file list sample.lst
  91.  
  92. C:>FSEARCH sample.lst /bart /simpson /gif
  93.  
  94.   displays any records that contain both "bart" and "simpson" and "gif"
  95.  
  96. C:>FSEARCH *.lst "/source code" /c++
  97.  
  98.   searches through any file in the current directory with the extension
  99.   lst for any records that contain both "source code" and "c++".
  100.  
  101.  
  102. Note that wildcards are NOT supported within a WORD search. Eg.:
  103.  
  104. C:>FSEARCH sample.lst /anyfile.*
  105.  
  106. will look for text that exactly matches "anyfile.*". The asterisk will not
  107. be expanded.
  108.  
  109.  
  110. PAUSING THE OUTPUT
  111. ------------------
  112. To display the output of FSEARCH one page at a time on your screen, use
  113. the DOS pipe feature and the MORE command.  For example:
  114.  
  115. C:>FSEARCH sample.lst /gif |MORE
  116.  
  117. Will search through the file list called sample.lst for the word "gif"
  118. and display the files it finds. Adding |MORE at the end of the command
  119. line will cause DOS to display information bound for the screen one page
  120. at a time and wait for you to press any key.  This must be the last
  121. parameter on the command line.
  122.  
  123. Note that when using this DOS feature, FSEARCH will not display anything
  124. on the screen until the entire file or files have been searched.  This may
  125. make the program appear to be hung up. But as long as you see your disk
  126. drive light flashing occasionally, be patient. See your DOS manual for
  127. more information about piping and the MORE command.
  128.  
  129. REDIRECTING THE OUTPUT
  130. ----------------------
  131. If you'd like to save the list of files that FSEARCH finds, you can do so
  132. by redirecting the output to a file.  This is how:
  133.  
  134. C:>FSEARCH sample.lst "/sound blaster" -A >blaster.fls
  135.  
  136. will search the file sample.lst for the phrase "sound blaster".  The -A
  137. switch turns off the ANSI.SYS screen codes as they are meaningless unless
  138. the output is destined for the screen. The > is the DOS redirection
  139. symbol. It will create or write over the file you specify right after the
  140. symbol. This must be the last parameter on the command line.  See your
  141. DOS manual for more information about redirection.
  142.  
  143. It is recommended that you always use the -A switch when redirecting
  144. output to a file. It won't harm anything if you don't, but the ANSI codes
  145. will be captured in the file and may make reading the output file
  146. confusing.
  147.  
  148. ABOUT USING ANSI.SYS
  149. --------------------
  150. Though it's not necessary, loading ANSI.SYS on your system allows FSEARCH
  151. to highlight the keyword or words on the screen that it finds. Loading
  152. ANSI.SYS is accomplished by putting the line DEVICE=ANSI.SYS in your
  153. system's CONFIG.SYS file. After adding that line, you must reboot your
  154. computer for the changes to take effect. See your DOS manual for further
  155. information. If you choose not load ANSI.SYS, use the -A switch when
  156. running FSEARCH to turn off the highlighting feature.
  157.  
  158. TO REGISTER
  159. -----------
  160. FSEARCH is shareware.  You may distribute this archived package freely in
  161. its original, unmodified form. If you like FSEARCH and plan to use it,
  162. please register it! The registration fees will help me recoup the large
  163. investment I've made in software development programs used to write this
  164. and other shareware programs. Send the registration fee of $10 to me at:
  165.  
  166.                      Timothy C. Barmann
  167.                      87 Marbury Ave.
  168.                      Pawtucket, RI 02860
  169.  
  170. For now, FSEARCH 1.0 works only with file lists created by PCBoard
  171. bulletin board systems. If enough people register this program, I plan to
  172. rewrite some of the software so it will support the file lists of other
  173. bulletin boards, including Ultra BBS and Wildcat BBS.
  174.  
  175. HISTORY
  176. -------
  177. V. 1.0 Initial release, March 1, 1992. Thanks to John Barmann and John
  178.        Granatino for their helpful suggestions.
  179.  
  180. OTHER PROGRAMS OF INTEREST
  181. --------------------------
  182. Look for PCB2REC.ZIP, another shareware program that will convert a
  183. PCBoard file list into a file containing ASCII delimited records that can
  184. be read by most database programs.  This will allow you to use your
  185. favorite database program to do more powerful searches and sorting of
  186. PCBoard file lists. Contact me if you can't find this program and you'd
  187. like to try it.
  188.  
  189. YOUR COMMENTS
  190. -------------
  191. I'd appreciate any questions, comments, suggestions and bug reports about
  192. FSEARCH 1.0.  Direct correspondence to me at the above address or through
  193. Compuserve: 72070,652 or the Internet: tim@bbs.sys.com.
  194.  
  195. CLOSING THOUGHTS
  196. ----------------
  197. Use this program at your own risk.  The author of FSEARCH is in no way
  198. associated with PCBoard software or its authors.  (He is a fan, though, of
  199. their excellent bulletin board software.)
  200.